Track order
This request retrieves order status and the location of the car assigned to the order.
Request syntax
GET http://b2b-api.go.yandex.ru/integration/2.0/orders/progress?order_id={order ID}
Request headers
Authorization: Bearer <OAuth-token>
OAuth access token. The steps to get a token are described in Getting started.
X-YaTaxi-Selected-Corp-Client-Id— client ID from the account. Required if multiple clients are available using the token.
Request parameters
This request has one required parameter:
order_id: ID of the order to be cancelled.
Response fields
The response may contain the following fields:
| Field | Description | Format |
|---|---|---|
status |
Order status. | String |
time_left_raw |
Time left until the driver arrives or the order ends, in seconds. | Number |
vehicle |
Information about the car’s location. Contains a location array of two values that determine the car’s coordinates. |
String |
Request example
GET http://b2b-api.go.yandex.ru/integration/2.0/orders/progress?order_id=191...280'
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>
Response example
An example response to this request looks like this:
{
"status": "finished",
"vehicle": {
"location": [
55.749884,
37.589688
]
}
}
Response codes
The response to this request may contain the following HTTP codes:
200: Request completed successfully.403:- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header
X-YaTaxi-Selected-Corp-Client-Id(returned if more than one client is available for the token). - SELECTED_CLIENT_ACCESS_DENIED: the header
X-YaTaxi-Selected-Corp-Client-Idcontains the client's ID, which this login does not have access to.
- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header
404: Order not found.
Was the article helpful?
Previous